home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic 5 Developer's Kit / vb5 dev kit.iso / dev / vbstyle / readme.txt next >
Encoding:
Text File  |  1996-02-05  |  2.8 KB  |  110 lines
  1. Code Stylist/VB -- Making you source code looks its best...
  2.  
  3.  
  4. Have you had to code quickly to meet a deadline?  Or perhaps you work with
  5. a team of programmers, each with their own unique style?  Or maybe you've
  6. inherited the source code from hell?  If you program for a living, chances 
  7. are you have had to look at some interesting source code.  So what can be
  8. done to make your life as a programmer easier?  Use the Code Stylist/VB on
  9. all of your Visual Basic 3.0 projects.
  10.  
  11. Code Stylist/VB is a source code formatting tool for Microsoft Visual Basic.
  12. Within a matter of minutes, Code Stylist/VB allows you to specify your 
  13. personal or company standard formatting preferences, process and format 
  14. all of the source code, and save the new clean code into a new directory.  
  15. It will even spell check your code and allow you to see all changes in a 
  16. side-by-side code comparison.
  17.  
  18.  
  19.  
  20. Code Stylist/VB includes:
  21.  
  22.  
  23. Automatic Insertion of Option Explicit
  24.  
  25.  
  26. Line splitting of:
  27.     Single line If Then statements
  28.     Multiple Dim as statements
  29.     Multiple Const statements
  30.     Multiple Statements separated by :'s
  31.  
  32.  
  33. Indentation
  34.  
  35. Formatting of all control statements allowing the for varying spaces per 
  36. each indent.  For example,
  37.  
  38.  
  39.     For x = 1 To 100
  40.     Debug.Print x
  41.     Next x
  42.  
  43.  
  44. becomes
  45.  
  46.  
  47.     For x = 1 To 100
  48.         Debug.Print x
  49.     Next
  50.  
  51.  
  52. Comments
  53.  
  54. Choose from over 10 options for single line comments and end of statement 
  55. comments. These options include placement of any the comments and creating 
  56. comment block lines to block off large numbers of comments in a row. This 
  57. makes reading code much easier.
  58.  
  59.  
  60. Comment Headers in Functions and Subs
  61.  
  62. Create a common header for all procedures and functions.  Imagine having the 
  63. following inserted before or after all of your subroutine declarations:
  64.  
  65.  
  66. ' -----------------------------------------------------------
  67. '  Name   :  CenterForm
  68. '  Author :  Your Name Here
  69. '  Date   :  12/12/95
  70. '  Params :  aForm as Form
  71. '  Purpose:  
  72. '
  73. ' DATE      WHO         WHAT
  74. ' --------  ---------- --------------------------------------
  75. '
  76. ' -----------------------------------------------------------
  77.  
  78.  
  79.  
  80. Blank Lines
  81.  
  82. Creating the spacing look you desire to make reading through the code 
  83. and conducting code reviews a painless process.
  84.  
  85.  
  86.  
  87. Spell Checking
  88.  
  89. Spell Check all the literals and/or the comments in the code.
  90.  
  91.  
  92.  
  93. Instant reporting
  94.  
  95. With the Integrated Visual Difference Engine, a project manager can easily 
  96. see where changes were made
  97.  
  98.  
  99.  
  100. Flexibility
  101.  
  102. One of The Code Stylist's greatest features is it's flexibility. Each 
  103. option is configurable by itself or as a group.   This gives the programmer 
  104. total control over how they want the code to turn out. It makes creating 
  105. and conforming to project standards a snap.
  106.  
  107.  
  108.  
  109. Copyright (c) 1995.  Cycloid Software.
  110.